Azure Maps Route Service (preview:2023-10-01)

2024/12/09 • 1 updated methods

Route_PostDirections (updated)
Description :  The `Route Directions` API is an HTTP `POST` request that returns the ideal route between an origin and destination for automobile (driving), commercial trucks and walking routes. The route passes through a series of waypoints if specified. A waypoint is a geographical location defined by longitude and latitude that is used for navigational purposes. The route considers factors such as current traffic and the typical road speeds on the requested day of the week and time of day. The API returns the distance, estimated travel time, and a representation of the route geometry. More routing information such as an optimized waypoint order or turn by turn instructions is also available, depending on the parameters used. The Route Directions considers local laws, vehicle dimensions, cargo type, max speed, bridge and tunnel heights to calculate the truck specific routes and avoid complex maneuvers and difficult roads. Not all trucks can travel the same routes as other vehicles due to certain restrictions based on the vehicle profile or cargo type. For example, highways often have separate speed limits for trucks, some roads don't allow trucks with flammable or hazardous materials, and there can be height and weight restriction on bridges. Up to 25 waypoints and 10 viaWaypoints between any two waypoints is supported for driving and walking routes. Each set of waypoints creates a separate route Leg. ViaWaypoints define the route path and can be used for route creation through specific locations, but they don't create route Legs. Truck routes support up to 150 waypoints but don't support viaWaypoints. For information about routing availability in countries/regions, see [Azure Maps routing coverage](https://learn.microsoft.com/azure/azure-maps/routing-coverage?pivots=route-v2). >[!Important] >By using this feature, you agree to the preview legal terms. For more information, see [Preview Supplemental Terms](https://azure.microsoft.com/en-us/support/legal/preview-supplemental-terms/).
Reference :  Link ¶

⚶ Changes

{
  "#id": "Route_PostDirections",
  "$parameters": {
    "routeDirectionsRequest": {
      "$properties": [
        {
          "#name": "departAt",
          "Description": {
            "new": "The date and time of departure from the origin point formatted as a `dateTime` value defined by [RFC 3339, section 5.6](https://www.rfc-editor.org/rfc/rfc3339#section-5.6). When a time zone offset is not specified, UTC will be assumed.\n\nExample: \"departAt\": \"2023-06-01T09:30:00.000-07:00\"",
            "old": "The date and time of departure from the origin point formatted as a `dateTime` value defined by [RFC 3339, section 5.6](https://www.rfc-editor.org/rfc/rfc3339#section-5.6). When a time zone offset is not specified, UTC will be assumed.\n\nExamples:\n\n\"departAt\": \"2023-06-01T09:30:00.000-07:00\""
          }
        }
      ]
    }
  }
}

⚼ Request

POST:  /route/directions
{
api-version:
{
Description: Version number of Azure Maps API. ,
Required: True ,
}
string ,
x-ms-client-id:
{
Description: Specifies which account is intended for usage in conjunction with the Microsoft Entra ID security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Microsoft Entra ID security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. ,
Required: False ,
}
string ,
Accept-Language:
{
Description: Language in which routing results should be returned. For more information, see [Localization support in Azure Maps](https://learn.microsoft.com/en-us/azure/azure-maps/supported-languages#routing-v2-services-preview-supported-languages). ,
Required: False ,
}
string ,
routeDirectionsRequest:
{
Description: Request body of RouteDirections API in GeoJSON format. ,
Required: True ,
}
{
type:
{
Description: Specifies the `GeoJSON` type. The only supported object type is `FeatureCollection`. For more information, see [RFC 7946](https://www.rfc-editor.org/rfc/rfc7946). ,
Enum:
{
FeatureCollection: Specifies the `GeoJSON` `FeatureCollection` object type. ,
}
,
Required: True ,
}
enum ,
features:
{
Description: Driving and walking routes are defined by a set of waypoints(stops) and viaWaypoints (intermediate locations that the route must pass through). You can have a maximum of 25 waypoints, and a maximum of 10 viaWaypoints between each set of waypoints. Truck route supports up to 150 waypoints and viaWaypoints are not supported. A route must have a minimum of 2 waypoints and the start and end points of the route cannot be viaWaypoints. Both waypoint and viaWaypoint locations must be specified as a valid GeoJSON Point feature object along with pointIndex that specifies the order of the locations. For more information on the GeoJSON format, see [RFC 7946](https://www.rfc-editor.org/rfc/rfc7946). ,
Required: True ,
}
[
{
type:
{
Description: Specifies the `GeoJSON` type. The only supported object type is Feature. For more information, see [RFC 7946](https://www.rfc-editor.org/rfc/rfc7946). ,
Enum:
{
Feature: Specifies the `GeoJSON` Feature object type. ,
}
,
Required: True ,
}
enum ,
geometry:
{
Description: A valid `GeoJSON Point` geometry type. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.1.2) for details. ,
Required: True ,
}
object ,
properties:
{
Description: Specifies the properties of a Waypoint which is a specific location or point along a route or trip that serves as a reference or stopping point. ,
Required: True ,
}
{
pointIndex:
{
Description: Identify and order the sequence of waypoints in the route. The default value is the `index value` of a features array. ,
Format: int64 ,
Required: False ,
}
integer ,
pointType:
{
Description: Waypoint type on the route. It can be a stop or an intermediate location that the route must pass through. ,
Enum:
{
waypoint: A waypoint is a specific location or point along a route or trip that serves as a reference or stopping point. ,
viaWaypoint: A viaWaypoint is a specific waypoint that must be passed through or visited along a route or trip. `Note`: Only supported for driving travelMode. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
travelMode:
{
Description: The mode of travel for the requested route. If not defined, the default value is "driving" that returns the route optimized for cars. `Note`: For truck travelMode, the requested truck route may not be available for the entire route. Where the truck route is not available for a particular section, the travelMode element of the response for that section will be "other". Example: "travelMode":"driving" ,
Enum:
{
driving: The returned routes are optimized for cars. ,
truck: The returned routes are optimized for large size trucks based on the vehicle specification. ,
walking: The returned routes are optimized for pedestrians, including the use of sidewalks. ,
}
,
Required: False ,
}
enum ,
departAt:
{
Description: The date and time of departure from the origin point formatted as a `dateTime` value defined by [RFC 3339, section 5.6](https://www.rfc-editor.org/rfc/rfc3339#section-5.6). When a time zone offset is not specified, UTC will be assumed. Example: "departAt": "2023-06-01T09:30:00.000-07:00" ,
Format: date-time ,
Required: False ,
}
string ,
arriveAt:
{
Description: The date and time of arrival at the destination point formatted as a `dateTime` value defined by [RFC 3339, section 5.6](https://www.rfc-editor.org/rfc/rfc3339#section-5.6). When a time zone offset is not specified, UTC will be assumed. The `arriveAt` parameter cannot be used in conjunction with `departAt`. Example: "arriveAt": "2023-06-01T09:30:00.000-07:00" ,
Format: date-time ,
Required: False ,
}
string ,
optimizeRoute:
{
Description: Specifies the parameter to use to optimize the route. If not defined, the default is "fastestWithoutTraffic" which returns the route to minimize the travel time without using current traffic information. Example: "optimizeRoute":"shortest" ,
Enum:
{
shortest: The route is calculated to minimize the distance. Traffic information is not used. ,
fastestWithoutTraffic: Finds the fastest route, without factoring in traffic information. ,
fastestAvoidClosureWithoutTraffic: The route is calculated to minimize the time and avoid road closures. No traffic information except for road closures is used in the calculation. `Note`: Only supported for driving travelMode. ,
fastestWithTraffic: The route is calculated to minimize the time using current traffic information. `Note`: Only supported for driving and truck travelMode. ,
}
,
Required: False ,
}
enum ,
optimizeWaypointOrder:
{
Description: Re-order the route waypoints using a fast heuristic algorithm to reduce the route cost specified with the optimize parameter. The origin and destination are excluded from the optimized waypoint and their position is considered fixed. Acceptable values are true or false. `Note`: Only supported for truck travelMode. ,
Required: False ,
}
boolean ,
avoid:
{
Description: Specifies restrictions that the route calculation should honor when determining the route. Avoid supports multiple values in a request and is only supported for the driving and truck travelMode. Example: "avoid": ["limitedAccessHighways", "tolls"] ,
Required: False ,
}
[
string ,
]
,
routeOutputOptions:
{
Description: Include the desired route information from the response. By default, the itinerary is included in the response. Supports multiple values such as "routeOutputOptions": ["routePath", "regionTravelSummary"] ,
Required: False ,
}
[
string ,
]
,
maxRouteCount:
{
Description: The maximum number of routes to return. Available for the driving and truck travel modes. For driving routes, this parameter supports routes with up to two waypoints in addition to the origin and destination and avoid parameter must not be set. Default: "maxRouteCount":1 Minimum: "maxRouteCount":1 Maximum: "maxRouteCount":3 ,
Format: int64 ,
Required: False ,
}
integer ,
heading:
{
Description: The initial directional heading of the vehicle in degrees starting at true North and continuing in clockwise direction. North is 0 degrees, east is 90 degrees, south is 180 degrees, west is 270 degrees. Possible values 0-359 ,
Format: int64 ,
Required: False ,
}
integer ,
vehicleSpec:
{
Description: Specifies the vehicle attributes such as size, weight, max speed, type of cargo for truck routing only. This helps avoid low bridge clearances, road restrictions, difficult right turns to provide the optimized truck route based on the vehicle specifications. `Note`: Only supported for truck travelMode ,
Required: False ,
}
{
isVehicleCommercial:
{
Description: Whether the vehicle is used for commercial purposes. Commercial vehicles may not be allowed to drive on some roads. ,
Required: False ,
}
boolean ,
length:
{
Description: Length of the vehicle in meters. A value of 0 means that length restrictions are not considered. ,
Format: double ,
Required: False ,
}
number ,
width:
{
Description: Width of the vehicle in meters. A value of 0 means that width restrictions are not considered. ,
Format: double ,
Required: False ,
}
number ,
height:
{
Description: Height of the vehicle in meters. A value of 0 means that height restrictions are not considered. ,
Format: double ,
Required: False ,
}
number ,
weight:
{
Description: Weight of the vehicle in kilograms. A value of 0 means that weight restrictions are not considered. ,
Format: int64 ,
Required: False ,
}
integer ,
maxSpeed:
{
Description: Maximum speed of the vehicle in km/hour. The max speed in the vehicle profile is used to check whether a vehicle is allowed on motorways. A value of 0 means that an appropriate value for the vehicle will be determined and applied during route planning. A non-zero value may be overridden during route planning. For example, the current traffic flow is 60 km/hour. If the vehicle maximum speed is set to 50 km/hour, the routing engine will consider 60 km/hour as this is the current situation. If the maximum speed of the vehicle is provided as 80 km/hour but the current traffic flow is 60 km/hour, then routing engine will again use 60 km/hour. ,
Format: int64 ,
Required: False ,
}
integer ,
axleWeight:
{
Description: Weight per axle of the vehicle in kg. A value of 0 means that weight restrictions per axle are not considered. ,
Format: int64 ,
Required: False ,
}
integer ,
axleCount:
{
Description: Number of axles on the vehicle. A value of 0 means that axle restrictions are not considered. ,
Format: int64 ,
Required: False ,
}
integer ,
loadType:
{
Description: Types of cargo that may be classified as hazardous materials and restricted from some roads. Available vehicleLoadType values are US Hazmat classes 1 through 9, plus generic classifications for use in other countries. Values beginning with USHazmat are for US routing while otherHazmat should be used for all other countries. vehicleLoadType supports multiple values in a request. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (200)

{
$schema:
{
Description: This object is returned from a successful call. ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code of the error that occurred. ,
}
string ,
}
,
$schema:
{
Description: Common error response for Azure Maps APIs to return error details for failed operations. ,
}
{
error:
{
Description: The error detail. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}